/*
 * MIT License
 *
 * Copyright (c) 2024-2048 冰羽
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package cn.star.framework.rbac.entity;

import cn.star.framework.annotation.SorterOrder;
import cn.star.framework.entity.AbstractIdEntity;
import cn.star.framework.rbac.core.IRbacRole;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonProperty.Access;
import java.util.List;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Transient;
import javax.persistence.UniqueConstraint;
import lombok.Data;
import org.hibernate.annotations.Comment;

/**
 * {@link IRbacRole}<br>
 *
 * @author zhaoweiping
 *     <p style='color: red'>Created on 2024-09-23 11:06:00
 * @since 3.0.0
 */
@Data
@Entity
@Table(
    name = "sys_role",
    uniqueConstraints = {
      @UniqueConstraint(columnNames = {"fk_tenant_id_", "code_"}),
    })
@org.hibernate.annotations.Table(appliesTo = "sys_role", comment = "角色")
public class Role extends AbstractIdEntity implements IRbacRole<Role> {
  /** 父Id {@link #id}，支持继承关系 */
  @Column(name = "fk_parent_id_", length = 32)
  @Comment(value = "父Id")
  private String parentId;

  /** 名称 */
  @Column(name = "name_", length = 64, nullable = false)
  @Comment(value = "名称")
  private String name;

  /** 代码 */
  @Column(name = "code_", length = 64, nullable = false)
  @Comment(value = "代码")
  @SorterOrder
  private String code;

  /** 描述 */
  @Column(name = "describe_")
  @Comment(value = "描述")
  private String describe;

  /** 子角色 */
  @Transient private List<Role> children;

  /**
   * {@link org.springframework.security.core.GrantedAuthority}
   *
   * @return 身份信息名称
   */
  @Override
  @Transient
  @JsonProperty(access = Access.WRITE_ONLY)
  public String getIdentityName() {
    // 考虑到授权时候使用的是Id，所以用户身份需要返回Id
    return this.getId();
  }
}
